<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    <a name="line.1"></a>
<FONT color="green">002</FONT>    /*<a name="line.2"></a>
<FONT color="green">003</FONT>     * Copyright (C) 2011 Archie L. Cobbs. All rights reserved.<a name="line.3"></a>
<FONT color="green">004</FONT>     *<a name="line.4"></a>
<FONT color="green">005</FONT>     * $Id: MapEntry.html 69 2011-04-12 02:00:17Z archie.cobbs $<a name="line.5"></a>
<FONT color="green">006</FONT>     */<a name="line.6"></a>
<FONT color="green">007</FONT>    <a name="line.7"></a>
<FONT color="green">008</FONT>    package org.dellroad.stuff.jibx;<a name="line.8"></a>
<FONT color="green">009</FONT>    <a name="line.9"></a>
<FONT color="green">010</FONT>    import java.util.Iterator;<a name="line.10"></a>
<FONT color="green">011</FONT>    import java.util.Map;<a name="line.11"></a>
<FONT color="green">012</FONT>    <a name="line.12"></a>
<FONT color="green">013</FONT>    import org.jibx.runtime.JiBXParseException;<a name="line.13"></a>
<FONT color="green">014</FONT>    <a name="line.14"></a>
<FONT color="green">015</FONT>    /**<a name="line.15"></a>
<FONT color="green">016</FONT>     * Utility class that makes it slightly easier to model {@link Map} properties in JiBX.<a name="line.16"></a>
<FONT color="green">017</FONT>     * This class can be used to represent entries in the map, each of which is modeled in XML as a separate XML element.<a name="line.17"></a>
<FONT color="green">018</FONT>     *<a name="line.18"></a>
<FONT color="green">019</FONT>     * &lt;p&gt;<a name="line.19"></a>
<FONT color="green">020</FONT>     * For example, suppose you have a class {@code Company} and want to add a {@code directory} property that has<a name="line.20"></a>
<FONT color="green">021</FONT>     * type {@code Map&lt;String, Person&gt;}:<a name="line.21"></a>
<FONT color="green">022</FONT>     * &lt;blockquote&gt;&lt;pre&gt;<a name="line.22"></a>
<FONT color="green">023</FONT>     * private Map&amp;lt;String, Person&amp;gt; = new HashMap&amp;lt;String, Person&amp;gt;();<a name="line.23"></a>
<FONT color="green">024</FONT>     *<a name="line.24"></a>
<FONT color="green">025</FONT>     * // Getter and setter for the "directory" property<a name="line.25"></a>
<FONT color="green">026</FONT>     * public Map&amp;lt;String, Person&amp;gt; getDirectory() {<a name="line.26"></a>
<FONT color="green">027</FONT>     *     return this.directory;<a name="line.27"></a>
<FONT color="green">028</FONT>     * }<a name="line.28"></a>
<FONT color="green">029</FONT>     * public void setDirectory(Map&amp;lt;String, Person&amp;gt; directory) {<a name="line.29"></a>
<FONT color="green">030</FONT>     *     this.directory = directory;<a name="line.30"></a>
<FONT color="green">031</FONT>     * }<a name="line.31"></a>
<FONT color="green">032</FONT>     * &lt;/pre&gt;&lt;/blockquote&gt;<a name="line.32"></a>
<FONT color="green">033</FONT>     *<a name="line.33"></a>
<FONT color="green">034</FONT>     * &lt;p&gt;<a name="line.34"></a>
<FONT color="green">035</FONT>     * Because the JiBX binding process modifies class files, you first need to create your own subclass of {@link MapEntry}<a name="line.35"></a>
<FONT color="green">036</FONT>     * that can be modified:<a name="line.36"></a>
<FONT color="green">037</FONT>     * &lt;blockquote&gt;&lt;pre&gt;<a name="line.37"></a>
<FONT color="green">038</FONT>     * public class DirectoryEntry extends MapEntry&amp;lt;String, Person&amp;gt; {<a name="line.38"></a>
<FONT color="green">039</FONT>     * }<a name="line.39"></a>
<FONT color="green">040</FONT>     * &lt;/pre&gt;&lt;/blockquote&gt;<a name="line.40"></a>
<FONT color="green">041</FONT>     *<a name="line.41"></a>
<FONT color="green">042</FONT>     * &lt;p&gt;<a name="line.42"></a>
<FONT color="green">043</FONT>     * Next, you would add these JiBX helper methods in {@code Company.java}:<a name="line.43"></a>
<FONT color="green">044</FONT>     * &lt;blockquote&gt;&lt;pre&gt;<a name="line.44"></a>
<FONT color="green">045</FONT>     * // JiBX "add-method" that adds a new entry to the directory<a name="line.45"></a>
<FONT color="green">046</FONT>     * void addDirectoryEntry(DirectoryEntry direntry) throws JiBXParseException {<a name="line.46"></a>
<FONT color="green">047</FONT>     *     MapEntry.add(this.directory, direntry);<a name="line.47"></a>
<FONT color="green">048</FONT>     * }<a name="line.48"></a>
<FONT color="green">049</FONT>     *<a name="line.49"></a>
<FONT color="green">050</FONT>     * // JiBX "iter-method" that iterates all entries in the directory<a name="line.50"></a>
<FONT color="green">051</FONT>     * Iterator&amp;lt;DirectoryEntry&amp;gt; iterateDirectory() {<a name="line.51"></a>
<FONT color="green">052</FONT>     *     return MapEntry.iterate(this.directory, DirectoryEntry.class);<a name="line.52"></a>
<FONT color="green">053</FONT>     * }<a name="line.53"></a>
<FONT color="green">054</FONT>     * &lt;/pre&gt;&lt;/blockquote&gt;<a name="line.54"></a>
<FONT color="green">055</FONT>     *<a name="line.55"></a>
<FONT color="green">056</FONT>     * &lt;p&gt;<a name="line.56"></a>
<FONT color="green">057</FONT>     * Then in your JiBX binding definition, you would do something like this:<a name="line.57"></a>
<FONT color="green">058</FONT>     * &lt;blockquote&gt;&lt;pre&gt;<a name="line.58"></a>
<FONT color="green">059</FONT>     * &amp;lt;binding package="com.example"&amp;gt;<a name="line.59"></a>
<FONT color="green">060</FONT>     *<a name="line.60"></a>
<FONT color="green">061</FONT>     *     &amp;lt;!-- Include XML mapping definition for a Person object (having type-name "person") --&amp;gt;<a name="line.61"></a>
<FONT color="green">062</FONT>     *     &amp;lt;include path="person.xml"/&amp;gt;<a name="line.62"></a>
<FONT color="green">063</FONT>     *<a name="line.63"></a>
<FONT color="green">064</FONT>     *     &amp;lt;!-- Define the XML mapping for one entry in the "directory" map --&amp;gt;<a name="line.64"></a>
<FONT color="green">065</FONT>     *     &amp;lt;mapping abstract="true" type-name="directory_entry" class="com.example.DirectoryEntry"&amp;gt;<a name="line.65"></a>
<FONT color="green">066</FONT>     *         &amp;lt;value name="name" get-method="getKey" set-method="setKey" type="java.lang.String" style="attribute"/&amp;gt;<a name="line.66"></a>
<FONT color="green">067</FONT>     *         &amp;lt;structure name="Person" get-method="getValue" set-method="setValue" map-as="person"/&amp;gt;<a name="line.67"></a>
<FONT color="green">068</FONT>     *     &amp;lt;/mapping&amp;gt;<a name="line.68"></a>
<FONT color="green">069</FONT>     *<a name="line.69"></a>
<FONT color="green">070</FONT>     *     &amp;lt;!-- Define XML mapping for a Company object --&amp;gt;<a name="line.70"></a>
<FONT color="green">071</FONT>     *     &amp;lt;mapping abstract="true" type-name="company" class="com.example.Company"&amp;gt;<a name="line.71"></a>
<FONT color="green">072</FONT>     *         &amp;lt;collection name="Directory" item-type="com.example.DirectoryEntry"<a name="line.72"></a>
<FONT color="green">073</FONT>     *           add-method="addDirectoryEntry" iter-method="iterateDirectory"&amp;gt;<a name="line.73"></a>
<FONT color="green">074</FONT>     *             &amp;lt;structure name="DirectoryEntry" map-as="directory_entry"/&amp;gt;<a name="line.74"></a>
<FONT color="green">075</FONT>     *         &amp;lt;/collection&amp;gt;<a name="line.75"></a>
<FONT color="green">076</FONT>     *         &amp;lt;!-- other properties... --&amp;gt;<a name="line.76"></a>
<FONT color="green">077</FONT>     *     &amp;lt;/mapping&amp;gt;<a name="line.77"></a>
<FONT color="green">078</FONT>     * &amp;lt;/binding&amp;gt;<a name="line.78"></a>
<FONT color="green">079</FONT>     * &lt;/pre&gt;&lt;/blockquote&gt;<a name="line.79"></a>
<FONT color="green">080</FONT>     *<a name="line.80"></a>
<FONT color="green">081</FONT>     * Then the resulting XML would end up looking something like this:<a name="line.81"></a>
<FONT color="green">082</FONT>     * &lt;blockquote&gt;&lt;pre&gt;<a name="line.82"></a>
<FONT color="green">083</FONT>     * &amp;lt;Company&amp;gt;<a name="line.83"></a>
<FONT color="green">084</FONT>     *     &amp;lt;Directory&amp;gt;<a name="line.84"></a>
<FONT color="green">085</FONT>     *         &amp;lt;DirectoryEntry name="George Washington"&amp;gt;<a name="line.85"></a>
<FONT color="green">086</FONT>     *             &amp;lt;Person&amp;gt;<a name="line.86"></a>
<FONT color="green">087</FONT>     *                  &amp;lt;!-- properties of George Washington... --&amp;gt;<a name="line.87"></a>
<FONT color="green">088</FONT>     *             &amp;lt;/Person&amp;gt;<a name="line.88"></a>
<FONT color="green">089</FONT>     *         &amp;lt;/DirectoryEntry&amp;gt;<a name="line.89"></a>
<FONT color="green">090</FONT>     *         &amp;lt;DirectoryEntry name="Betsy Ross"&amp;gt;<a name="line.90"></a>
<FONT color="green">091</FONT>     *             &amp;lt;Person&amp;gt;<a name="line.91"></a>
<FONT color="green">092</FONT>     *                  &amp;lt;!-- properties of Betsy Ross... --&amp;gt;<a name="line.92"></a>
<FONT color="green">093</FONT>     *             &amp;lt;/Person&amp;gt;<a name="line.93"></a>
<FONT color="green">094</FONT>     *         &amp;lt;/DirectoryEntry&amp;gt;<a name="line.94"></a>
<FONT color="green">095</FONT>     *     &amp;lt;/Directory&amp;gt;<a name="line.95"></a>
<FONT color="green">096</FONT>     *     &amp;lt;!-- other properties... --&amp;gt;<a name="line.96"></a>
<FONT color="green">097</FONT>     * &amp;lt;/Company&amp;gt;<a name="line.97"></a>
<FONT color="green">098</FONT>     * &lt;/pre&gt;&lt;/blockquote&gt;<a name="line.98"></a>
<FONT color="green">099</FONT>     * &lt;p&gt;<a name="line.99"></a>
<FONT color="green">100</FONT>     * Note that during unmarshalling, the &lt;code&gt;Map&lt;/code&gt; itself is not created; it is expected to already exist<a name="line.100"></a>
<FONT color="green">101</FONT>     * and be empty. This will be the case if you provide a field initializer as in the example above.<a name="line.101"></a>
<FONT color="green">102</FONT>     */<a name="line.102"></a>
<FONT color="green">103</FONT>    public class MapEntry&lt;K, V&gt; {<a name="line.103"></a>
<FONT color="green">104</FONT>    <a name="line.104"></a>
<FONT color="green">105</FONT>        private K key;<a name="line.105"></a>
<FONT color="green">106</FONT>        private V value;<a name="line.106"></a>
<FONT color="green">107</FONT>    <a name="line.107"></a>
<FONT color="green">108</FONT>        /**<a name="line.108"></a>
<FONT color="green">109</FONT>         * Get this map entry's key.<a name="line.109"></a>
<FONT color="green">110</FONT>         */<a name="line.110"></a>
<FONT color="green">111</FONT>        public K getKey() {<a name="line.111"></a>
<FONT color="green">112</FONT>            return this.key;<a name="line.112"></a>
<FONT color="green">113</FONT>        }<a name="line.113"></a>
<FONT color="green">114</FONT>        public void setKey(K key) {<a name="line.114"></a>
<FONT color="green">115</FONT>            this.key = key;<a name="line.115"></a>
<FONT color="green">116</FONT>        }<a name="line.116"></a>
<FONT color="green">117</FONT>    <a name="line.117"></a>
<FONT color="green">118</FONT>        /**<a name="line.118"></a>
<FONT color="green">119</FONT>         * Get this map entry's value.<a name="line.119"></a>
<FONT color="green">120</FONT>         */<a name="line.120"></a>
<FONT color="green">121</FONT>        public V getValue() {<a name="line.121"></a>
<FONT color="green">122</FONT>            return this.value;<a name="line.122"></a>
<FONT color="green">123</FONT>        }<a name="line.123"></a>
<FONT color="green">124</FONT>        public void setValue(V value) {<a name="line.124"></a>
<FONT color="green">125</FONT>            this.value = value;<a name="line.125"></a>
<FONT color="green">126</FONT>        }<a name="line.126"></a>
<FONT color="green">127</FONT>    <a name="line.127"></a>
<FONT color="green">128</FONT>        /**<a name="line.128"></a>
<FONT color="green">129</FONT>         * Helper method intended to be used by a custom JiBX "iter-method".<a name="line.129"></a>
<FONT color="green">130</FONT>         * This method returns an iterator that iterates over all entries in the given map.<a name="line.130"></a>
<FONT color="green">131</FONT>         *<a name="line.131"></a>
<FONT color="green">132</FONT>         * @param &lt;K&gt; type of map keys<a name="line.132"></a>
<FONT color="green">133</FONT>         * @param &lt;V&gt; type of map values<a name="line.133"></a>
<FONT color="green">134</FONT>         * @param map map to iterate<a name="line.134"></a>
<FONT color="green">135</FONT>         * @param entryClass the subclass of {@link MapEntry} used for iterated elements; must have a default constructor<a name="line.135"></a>
<FONT color="green">136</FONT>         * @return map entry iterator<a name="line.136"></a>
<FONT color="green">137</FONT>         */<a name="line.137"></a>
<FONT color="green">138</FONT>        public static &lt;K, V, E extends MapEntry&lt;K, V&gt;&gt; Iterator&lt;E&gt; iterate(Map&lt;K, V&gt; map, final Class&lt;E&gt; entryClass) {<a name="line.138"></a>
<FONT color="green">139</FONT>            final Iterator&lt;Map.Entry&lt;K, V&gt;&gt; entryIterator = map.entrySet().iterator();<a name="line.139"></a>
<FONT color="green">140</FONT>            return new Iterator&lt;E&gt;() {<a name="line.140"></a>
<FONT color="green">141</FONT>    <a name="line.141"></a>
<FONT color="green">142</FONT>                @Override<a name="line.142"></a>
<FONT color="green">143</FONT>                public boolean hasNext() {<a name="line.143"></a>
<FONT color="green">144</FONT>                    return entryIterator.hasNext();<a name="line.144"></a>
<FONT color="green">145</FONT>                }<a name="line.145"></a>
<FONT color="green">146</FONT>    <a name="line.146"></a>
<FONT color="green">147</FONT>                @Override<a name="line.147"></a>
<FONT color="green">148</FONT>                public E next() {<a name="line.148"></a>
<FONT color="green">149</FONT>                    Map.Entry&lt;K, V&gt; entry = entryIterator.next();<a name="line.149"></a>
<FONT color="green">150</FONT>                    E mapEntry;<a name="line.150"></a>
<FONT color="green">151</FONT>                    try {<a name="line.151"></a>
<FONT color="green">152</FONT>                        mapEntry = entryClass.newInstance();<a name="line.152"></a>
<FONT color="green">153</FONT>                    } catch (Exception e) {<a name="line.153"></a>
<FONT color="green">154</FONT>                        throw new RuntimeException("unexpected exception", e);<a name="line.154"></a>
<FONT color="green">155</FONT>                    }<a name="line.155"></a>
<FONT color="green">156</FONT>                    mapEntry.setKey(entry.getKey());<a name="line.156"></a>
<FONT color="green">157</FONT>                    mapEntry.setValue(entry.getValue());<a name="line.157"></a>
<FONT color="green">158</FONT>                    return mapEntry;<a name="line.158"></a>
<FONT color="green">159</FONT>                }<a name="line.159"></a>
<FONT color="green">160</FONT>    <a name="line.160"></a>
<FONT color="green">161</FONT>                @Override<a name="line.161"></a>
<FONT color="green">162</FONT>                public void remove() {<a name="line.162"></a>
<FONT color="green">163</FONT>                    entryIterator.remove();<a name="line.163"></a>
<FONT color="green">164</FONT>                }<a name="line.164"></a>
<FONT color="green">165</FONT>            };<a name="line.165"></a>
<FONT color="green">166</FONT>        }<a name="line.166"></a>
<FONT color="green">167</FONT>    <a name="line.167"></a>
<FONT color="green">168</FONT>        /**<a name="line.168"></a>
<FONT color="green">169</FONT>         * Helper method intended to be used by a custom JiBX "add-method".<a name="line.169"></a>
<FONT color="green">170</FONT>         * If there is an existing entry with the same key, a {@link JiBXParseException} is thrown.<a name="line.170"></a>
<FONT color="green">171</FONT>         *<a name="line.171"></a>
<FONT color="green">172</FONT>         * @param map map to which to add an new entry<a name="line.172"></a>
<FONT color="green">173</FONT>         * @param entry new entry to add<a name="line.173"></a>
<FONT color="green">174</FONT>         * @throws JiBXParseException if the map already contains an entry with the given key<a name="line.174"></a>
<FONT color="green">175</FONT>         */<a name="line.175"></a>
<FONT color="green">176</FONT>        public static &lt;K, V&gt; void add(Map&lt;K, V&gt; map, MapEntry&lt;? extends K, ? extends V&gt; entry) throws JiBXParseException {<a name="line.176"></a>
<FONT color="green">177</FONT>            MapEntry.add(map, entry, false);<a name="line.177"></a>
<FONT color="green">178</FONT>        }<a name="line.178"></a>
<FONT color="green">179</FONT>    <a name="line.179"></a>
<FONT color="green">180</FONT>        /**<a name="line.180"></a>
<FONT color="green">181</FONT>         * Helper method intended to be used by a custom JiBX "add-method".<a name="line.181"></a>
<FONT color="green">182</FONT>         *<a name="line.182"></a>
<FONT color="green">183</FONT>         * @param map map to which to add an new entry<a name="line.183"></a>
<FONT color="green">184</FONT>         * @param entry new entry to add<a name="line.184"></a>
<FONT color="green">185</FONT>         * @param allowDuplicate {@code true} to replace any existing entry having the same key,<a name="line.185"></a>
<FONT color="green">186</FONT>         *  or {@code false} to throw a {@link JiBXParseException} if there is an existing entry<a name="line.186"></a>
<FONT color="green">187</FONT>         * @throws JiBXParseException if {@code allowDuplicate} is {@code false} and an entry<a name="line.187"></a>
<FONT color="green">188</FONT>         *  with the same key already exists in {@code map}<a name="line.188"></a>
<FONT color="green">189</FONT>         */<a name="line.189"></a>
<FONT color="green">190</FONT>        public static &lt;K, V&gt; void add(Map&lt;K, V&gt; map, MapEntry&lt;? extends K, ? extends V&gt; entry, boolean allowDuplicate)<a name="line.190"></a>
<FONT color="green">191</FONT>          throws JiBXParseException {<a name="line.191"></a>
<FONT color="green">192</FONT>            K key = entry.getKey();<a name="line.192"></a>
<FONT color="green">193</FONT>            V value = entry.getValue();<a name="line.193"></a>
<FONT color="green">194</FONT>            if (!allowDuplicate &amp;&amp; map.containsKey(key))<a name="line.194"></a>
<FONT color="green">195</FONT>                throw new JiBXParseException("duplicate key in map", "" + key);<a name="line.195"></a>
<FONT color="green">196</FONT>            map.put(key, value);<a name="line.196"></a>
<FONT color="green">197</FONT>        }<a name="line.197"></a>
<FONT color="green">198</FONT>    }<a name="line.198"></a>
<FONT color="green">199</FONT>    <a name="line.199"></a>




























































</PRE>
</BODY>
</HTML>
